Authorize recurring payment

This page will guide you through the authorization requests used by journey 1

Authorization request for recurring payment

Request

POST 'https://apisandbox.delbank.com.br/baas/api/v1/automatic-pix/authorization'

Headers

Name	Description
x-delbank-api-key	Required. API key
idempotencyKey	Required. Guid

Body

{
  "id": "RR1234567820250429ABCDE122125",
  "frequencyType": 1,
  "startDate": "2025-05-29",
  "endDate": "2025-12-01",
  "amount": 150.75,
  "payer": {
    "ispbCode": "38224857",
    "type": 0,
    "document": 12345678910,
    "branch": "0001",
    "number": "31747"
  },
  "contractNumber": "CONTRATO123",
  "description": "Assinatura Premium"
}

Response

The status code 200 indicates success in the query.

Being succeeded, the return will have the following fields in Json format:

Answering authorization request

Request

PUT 'https://apisandbox.delbank.com.br/baas/api/v1/automatic-pix/authorization/:identifier'

Headers

Name	Description
x-delbank-api-key	Required. API key
idempotencyKey	Required. Guid

Path Parameters:

Name	Type	Description
identifier	string	Required. Authorization identifier

Body

{
"id":"RR0435879820240605njua7shf40o",
"authorize":true,
"payerName":"Fulano da Silva",
"payerType":0
}

Response

The status code 200 indicates success in the query.

Being succeeded, the return will have the following fields in Json format:

{
"idempotencyKey":"70F945C1-9024-4123-1001-A1DE2A0000D1",
"createdAt":"2024-06-13T10:10:05.025Z",
"id":"RR0435879820240605njua7shf40o"
}